home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 010a / pltsr.zip / README.TXT < prev   
Text File  |  1991-10-04  |  10KB  |  271 lines
  1.  
  2.     PiloTSR -- BOB/SWOTL Pilot File Backup/Restore Utility
  3.     
  4.     Copyright (c) 1991 by Steve "Auger" Edwards
  5.     All rights reserved.
  6.  
  7.     This program may be copied and distributed freely. It is
  8.     provided as-is and with no warranty, either expressed or 
  9.     implied. Every effort has been made to ensure compatibility
  10.     and safe operation with other programs, but no guarantees
  11.     are made as to its compatibility with specific programs and/
  12.     or operating systems. The user bears full responsibility for
  13.     any lost data and/or other damage(s) caused by the use of
  14.     this program.
  15.     
  16.     If you find what you feel is a "bug" in this program, please
  17.     contact me via CompuServe's FSFORUM, section 7 (Historic
  18.     Air Combat). Please post your message private to UID 71610,2736 
  19.     with a message title of "PiloTSR Bugs" or something similar.
  20.     
  21.     This program has been tested and found reliable from within
  22.     both BOB and SWOTL on a Dell 16mhz 386sx running DOS 3.3
  23.     and QEMM 5.0.
  24.     
  25.     
  26.                 ------------    
  27.                 Introduction
  28.                 ------------
  29.                 
  30.   PiloTSR is a memory-resident (TSR) program designed to ease the pain of
  31.   killing your BOB and SWOTL pilots and to simplify their resurrection. It
  32.   works by making copies of your pilot files and restoring them at the press
  33.   of a key, and all from within the game -- there is no need to exit to DOS.
  34.  
  35.   Let's say that you're playing SWOTL, and you're flying as a P-47 pilot
  36.   (Dual-Role) who is twelve missions into his second tour of duty. Due to
  37.   a slight error in judgement, you plow face-first into that machine gun 
  38.   tower you were shooting at, thus bringing your otherwise illustrious 
  39.   career to a very sudden end. Not to fear! Simply exit back to the Main
  40.   Screen and press a key, and voila! your pilot is restored (you can verify
  41.   this by selecting Combat Records and looking at your pilot's stats).
  42.   
  43.   
  44.                   ------------
  45.                    Setup
  46.                 ------------
  47.   
  48.   There are only four things you need to do to set up PiloTSR:
  49.   
  50.       1)  Copy PILOTSR.EXE to your hard disk and make sure the
  51.         directory you put it in is on your path,
  52.         
  53.       2)  Create a directory to hold the backup pilot files,
  54.     
  55.     3)  Create a .LST file that contains the names of the pilots
  56.         you want to save and restore, and
  57.         
  58.     4)  Run PiloTSR, specifying the Program and Backup 
  59.         directories and the name of your .LST file.
  60.         
  61.   
  62.                   ------------
  63.                  .LST Files
  64.                 ------------
  65.                 
  66.   In order to save your pilot files, PiloTSR has to know what the filenames
  67.   are. PiloTSR accomplishes this by reading a list of filenames from a .LST 
  68.   file (which is just a fancy name for a text file containing a list of 
  69.   names).
  70.   
  71.   The rules for creating .LST files are very simple: 
  72.   
  73.       1)  There should be no blank lines or spaces
  74.     
  75.     2)  There should only be one filename per line
  76.     
  77.     3)  Filenames should be complete, ie. name and extension,
  78.         and appear only once in the file
  79.     
  80.     4)  There can be no more than 25 filenames per .LST file
  81.     
  82.     5)  All .LST files should reside in the Backup directory
  83.  
  84.     
  85.   The following is an example of a .LST file:
  86.   
  87. ----------------------- Beginning of file
  88. AUGER.109
  89. MANFRED.110
  90. EDDIE.RAF
  91. ROGER.RAF
  92. STUPID.J87
  93. BLIND.J88
  94. ----------------------- End of file
  95.     
  96.   As you can see, the pilot names don't have to be in any order, and you can
  97.   mix and match pilots of different types. You can even include BOB and SWOTL
  98.   pilots in the same .LST file, but you would then wind up with SWOTL pilots
  99.   in your BOB directory and vice-versa. 
  100.   
  101.   I suggest organizing your .LST files so that the pilots that fly together 
  102.   are in the same .LST file, ie. you may have some P-51 pilots and some B-17 
  103.   crews in the same .LST file, a .LST file just for your Go-229 pilots, 
  104.   another for RAF pilots, etc.
  105.                 
  106.   A quick and simple way to make .LST files is to do a DIR of the files you're
  107.   interested in (ex: DIR *.USA) and redirect the output to a file, which you
  108.   can then edit with a text editor or word processor. This can be done at the
  109.   DOS command prompt by typing in (for example):
  110.   
  111.           DIR *.109 > 109.LST
  112.         
  113.   and then editing the created file (in this case 109.LST) to remove the
  114.   directory listing header, file sizes and dates, and bytes free. By making 
  115.   good use of the DOS wildcard characters "*" and "?", you can generate a list 
  116.   pretty close to what you want with a minimum of editing.
  117.                 
  118.                 
  119.                   ------------
  120.                   Running
  121.                 ------------
  122.                 
  123.   To load PiloTSR, type in the following command:
  124.   
  125.           PILOTSR /L=LSTfile /P=ProgramDIR /B=BackupDIR
  126.     
  127.   where:    LSTfile        is the name of the .LST file (without
  128.                   extension) that contains the names of
  129.                 the files to be backed up and restored
  130.                 
  131.         ProgramDIR    is the full path (drive and directory) where 
  132.                 the program resides, with no final backslash 
  133.                 (ex: "C:\BOB", not "C:\BOB\")
  134.                 
  135.         BackupDIR    is the full path (drive and directory) where
  136.                 PiloTSR will store the backup files, with
  137.                 no final backslash (ex: "C:\BOB\PILOTS", not
  138.                 "C:\BOB\PILOTS\") .LST files are also stored
  139.                 in this directory.
  140.         
  141.   For eaxmple: if BOB resided in C:\BOB and you wanted your backup files to be
  142.   kept in D:\BACKUP and the name of your .LST file (located in D:\BACKUP) was
  143.   109.LST, you would type in the following:
  144.   
  145.           PILOTSR /L=109 /P=C:\BOB /B=D:\BACKUP
  146.   
  147.   Once loaded PiloTSR stays in the background until you press one of the
  148.   following key combinations:
  149.   
  150.       [Ctrl-Alt-B]        Backup the files listed in the .LST file
  151.                 (copy them from the Program directory to
  152.                 the Backup directory)
  153.     
  154.     [Ctrl-Alt-R]        Restore the files listed in the .LST file
  155.                 (copy them from the Backup directory to
  156.                 the Program directory)
  157.     
  158.     [Ctrl-Alt-U]        Unload (remove from memory) PiloTSR
  159.     
  160.     
  161.   * Note *    You can only unload PiloTSR if you are at the DOS command 
  162.             prompt and you are not "shelled out" from another program. 
  163.         Also, loading additional memory-resident programs after 
  164.         PiloTSR may keep it from unloading.
  165.   
  166.   If you forget the command keys, run PiloTSR again (without any command line
  167.   parameters) and it will list them for you.
  168.   
  169.   
  170.   When resident, PiloTSR communicates with you via a series of tones: 
  171.   
  172.     A series of short beeps indicates file access in progress
  173.     
  174.     A quick high-low-high beep indicates successfull completion
  175.     of a file copy, either backup or restore
  176.     
  177.     A long high-low indicates failure of a file copy or the inability
  178.     to unload
  179.     
  180.     A long low-high indicates a successful unload
  181.     
  182.     
  183.   After loading PiloTSR it would be a good idea to make an initial backup of 
  184.   your pilot files before entering the game (PiloTSR does *not* do this 
  185.   automatically). Press [Ctrl-Alt-B] and wait for the completion beep, then 
  186.   run your game normally.
  187.   
  188.   Once in the middle of the game you can backup and restore your files at any
  189.   time, but I would suggest doing so only at a main menu. Although I've made
  190.   every effort to make PiloTSR bullet-proof, it is still possible to really
  191.   screw things up by trying to backup or restore files at the same time the
  192.   game is trying to update them.
  193.   
  194.   If you are viewing a pilot file when you restore, you probably won't see
  195.   the data change right before your eyes; but if you exit out of the view
  196.   screen and get right back in, you should see the restored pilot data. In
  197.   some of SWOTL's menus there is a "retry" button; pressing it should have 
  198.   the same affect.
  199.   
  200.   
  201.                   ------------
  202.                 Advanced Use
  203.                 ------------
  204.                 
  205.   Once PiloTSR is loaded you can retrieve the current settings by running
  206.   PiloTSR again with no command line parameters. 
  207.   
  208.   You can also change the Program and Backup directories and the current .LST
  209.   file by running PiloTSR with different parameters. There is no need to
  210.   unload PiloTSR first.
  211.   
  212.   There is nothing in PiloTSR that precludes its use with other programs. If
  213.   you wanted to, you could set it up to save and restore your RB ROSTER.DAT 
  214.   file or your F16CP pilot files. However:
  215.   
  216.       PiloTSR HAS NOT BEEN TESTED WITH ANY PROGRAMS OTHER THAN 
  217.     BOB AND SWOTL AND I CAN THEREFORE NOT MAKE ANY CLAIMS AS 
  218.     TO ITS COMPATIBILITY WITH OTHER PROGRAMS OR ITS SUITABILITY
  219.     FOR A PARTICULAR APPLICATION. I REMIND YOU AGAIN THAT YOU
  220.     USE THIS PROGRAM AT YOUR OWN RISK.
  221.                 
  222.                 
  223.                   ------------
  224.                   Problems?
  225.                 ------------
  226.                 
  227.   If you have problems loading PiloTSR, check the following:
  228.   
  229.       1)  Make sure that you aren't putting an ending backslash on
  230.         the ProgramDIR and BackupDIR parameters (ei. "C:\BOB", not
  231.         "C:\BOB\")
  232.         
  233.     2)  Make sure that you aren't putting a file extension on the
  234.         LSTfile parameter (ei. "USA" not "USA.LST")
  235.         
  236.     3)  Make sure that your .LST file is located in the Backup 
  237.         directory
  238.         
  239.         
  240.   If PiloTSR loads but you get a failure tone when you try to backup or
  241.   restore files:
  242.   
  243.     1)  If you're trying to backup your files, make sure the files
  244.         exist in the Program directory
  245.         
  246.     2)  If you're trying to restore your files, make sure the files
  247.         exist in the Backup Directory
  248.         
  249.       3)  Make sure that each filename listed in your .LST file 
  250.         is correct; check for misspellings, missing file extensions,
  251.         and extra characters
  252.         
  253.     4)  Make sure you have enough disk space to copy the selected
  254.         files; remember, they'll be in two places at once so they'll
  255.         take up twice the normal space
  256.         
  257.         
  258.   If you are unable to unload PiloTSR:
  259.   
  260.       1)  Make sure you aren't "shelled out"; type "EXIT" and see if
  261.         you return to another program
  262.         
  263.     2)  Check to see if any TSRs were loaded after PiloTSR; unload
  264.         them first
  265.         
  266.         
  267.   I hope you have as much fun using PiloTSR as I had making it. Good luck,
  268.   and happy hunting!
  269.   
  270.                           - Steve "Auger" Edwards
  271.                           Oct 3, 1991